All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.JMenuItem

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.sun.java.swing.AbstractButton
                                   |
                                   +----com.sun.java.swing.JMenuItem

public class JMenuItem
extends AbstractButton
implements Accessible, MenuElement
An implementation of a MenuItem. A menu item is essentially a button sitting in a list. When the user selects the "button", the action associated with the menu item is performed. A JMenuItem contained in a JPopupMenu performs exactly that function.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JMenuItem key assignments.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:
JPopupMenu, JMenu, JCheckBoxMenuItem, JRadioButtonMenuItem

Constructor Index

 o JMenuItem()
Creates a menuItem with no set text or icon.
 o JMenuItem(Icon)
Creates a menuItem with an icon.
 o JMenuItem(String)
Creates a menuItem with text.
 o JMenuItem(String, Icon)
Creates a menuItem with the supplied text and icon.
 o JMenuItem(String, int)
Creates a menuItem with the specified text and keyboard mnemonic.

Method Index

 o getAccelerator()
 o getAccessibleContext()
Get the AccessibleContext associated with this JComponent
 o getComponent()
This method returns the java.awt.Component used to paint this object.
 o getSubElements()
This method returns an array containing the sub-menu components for this menu component.
 o getUIClassID()
Returns the name of the L&F class that renders this component.
 o init(String, Icon)
Initialize the menu item with the specified text and icon.
 o isArmed()
Returns whether the menu item is "armed".
 o menuSelectionChanged(boolean)
Called by the MenuSelectionManager when the MenuElement is selected or unselected.
 o processKeyEvent(KeyEvent, MenuElement[], MenuSelectionManager)
Implemented to be a MenuElement.
 o processMouseEvent(MouseEvent, MenuElement[], MenuSelectionManager)
Process a mouse event.
 o setAccelerator(KeyStroke)
 o setArmed(boolean)
Identifies the menu item as "armed".
 o setEnabled(boolean)
Enable or disable the menu item.
 o setUI(MenuItemUI)
Sets the L&F object that renders this component.
 o updateUI()
Notification from the UIFactory that the L&F has changed.

Constructors

 o JMenuItem
 public JMenuItem()
Creates a menuItem with no set text or icon.

 o JMenuItem
 public JMenuItem(Icon icon)
Creates a menuItem with an icon.

Parameters:
icon - the icon of the MenuItem.
 o JMenuItem
 public JMenuItem(String text)
Creates a menuItem with text.

Parameters:
text - the text of the MenuItem.
 o JMenuItem
 public JMenuItem(String text,
                  Icon icon)
Creates a menuItem with the supplied text and icon.

Parameters:
text - the text of the MenuItem.
icon - the icon of the MenuItem.
 o JMenuItem
 public JMenuItem(String text,
                  int mnemonic)
Creates a menuItem with the specified text and keyboard mnemonic.

Parameters:
text - the text of the MenuItem.
mnemonic - the keyboard mnemonic for the MenuItem

Methods

 o init
 protected void init(String text,
                     Icon icon)
Initialize the menu item with the specified text and icon.

Parameters:
text - the text of the MenuItem.
icon - the icon of the MenuItem.
Overrides:
init in class AbstractButton
 o setUI
 public void setUI(MenuItemUI ui)
Sets the L&F object that renders this component.

Parameters:
ui - the MenuItemUI L&F object
See Also:
getUI
 o updateUI
 public void updateUI()
Notification from the UIFactory that the L&F has changed. Called to replace the UI with the latest version from the UIFactory.

Overrides:
updateUI in class AbstractButton
See Also:
updateUI
 o getUIClassID
 public String getUIClassID()
Returns the name of the L&F class that renders this component.

Returns:
"MenuItemUI"
Overrides:
getUIClassID in class JComponent
See Also:
getUIClassID, getUI
 o setArmed
 public void setArmed(boolean b)
Identifies the menu item as "armed". If the mouse button is released while it is over this item, the menu's action event will fire. If the mouse button is released elsewhere, the event will not fire and the menu item will be disarmed.

Parameters:
b - true to arm the menu item so it can be selected
 o isArmed
 public boolean isArmed()
Returns whether the menu item is "armed".

Returns:
true if the menu item is armed, and it can be selected
See Also:
setArmed
 o setEnabled
 public void setEnabled(boolean b)
Enable or disable the menu item.

Parameters:
b - true to enable the item
Overrides:
setEnabled in class AbstractButton
 o setAccelerator
 public void setAccelerator(KeyStroke keyStroke)
 o getAccelerator
 public KeyStroke getAccelerator()
 o processMouseEvent
 public void processMouseEvent(MouseEvent event,
                               MenuElement path[],
                               MenuSelectionManager manager)
Process a mouse event. event is a MouseEvent with source being the receiving component. componentPath is the path of the receiving MenuElement in the menu hierarchy. manager is the MenuSelectionManager for the menu hierarchy. This method should process the MouseEvent and change the menu selection if necessary by using MenuSelectionManager's API.

Note: you do not have to forward the event to sub-components. This is done automatically by the MenuSelectionManager

 o processKeyEvent
 public void processKeyEvent(KeyEvent e,
                             MenuElement path[],
                             MenuSelectionManager manager)
Implemented to be a MenuElement. This message is forwarded to the UI

 o menuSelectionChanged
 public void menuSelectionChanged(boolean isIncluded)
Called by the MenuSelectionManager when the MenuElement is selected or unselected.

Parameters:
isIncluded - true if this menu item is on the part of the menu path that changed, false if this menu is part of the a menu path that changed, but this particular part of that path is still the same
See Also:
setSelectedPath
 o getSubElements
 public MenuElement[] getSubElements()
This method returns an array containing the sub-menu components for this menu component.

Returns:
an array of MenuElements
 o getComponent
 public Component getComponent()
This method returns the java.awt.Component used to paint this object. The returned component will be used to convert events and detect if an event is inside a menu component.

Returns:
the Component that paints this menu item
 o getAccessibleContext
 public AccessibleContext getAccessibleContext()
Get the AccessibleContext associated with this JComponent

Returns:
the AccessibleContext of this JComponent
Overrides:
getAccessibleContext in class JComponent

All Packages  Class Hierarchy  This Package  Previous  Next  Index